Skip to content

ffi: add new methods and error codes#62762

Merged
nodejs-github-bot merged 3 commits intonodejs:mainfrom
ShogunPanda:ffi-followup
Apr 19, 2026
Merged

ffi: add new methods and error codes#62762
nodejs-github-bot merged 3 commits intonodejs:mainfrom
ShogunPanda:ffi-followup

Conversation

@ShogunPanda
Copy link
Copy Markdown
Contributor

@ShogunPanda ShogunPanda commented Apr 15, 2026

As promised to @justjake, also the following followups requested in #62072 (comment):

  • Added ffi.exportArrayBuffer(...) and ffi.exportArrayBufferView(...).
  • Added raw pointer helper ffi.getRawPointer(source) (Buffer | ArrayBuffer | ArrayBufferView), with strong “unsafe/dangerous” docs and tests.
  • Moved byte-export copying to native code (exportBytes) to avoid extra JS Buffer wrapper allocations.

@ShogunPanda ShogunPanda requested review from bengl and jasnell April 15, 2026 18:28
@nodejs-github-bot
Copy link
Copy Markdown
Collaborator

nodejs-github-bot commented Apr 15, 2026

Review requested:

  • @nodejs/config
  • @nodejs/gyp
  • @nodejs/performance

@nodejs-github-bot nodejs-github-bot added lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels Apr 15, 2026
@ShogunPanda ShogunPanda mentioned this pull request Apr 15, 2026
Closed
@justjake
Copy link
Copy Markdown

justjake commented Apr 15, 2026 •
edited
Loading

Great! Thank you. It looks like I won't need my own unsafe-pointer once node:ffi gets stabilized 🎉 😄

@justjake justjake mentioned this pull request Apr 15, 2026
Open
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 15, 2026 •
edited
Loading

Codecov Report

❌ Patch coverage is 60.71429% with 88 lines in your changes missing coverage. Please review.
✅ Project coverage is 89.67%. Comparing base (d7ab027) to head (0a2bfad).
⚠️ Report is 47 commits behind head on main.

Files with missing lines Patch % Lines
src/ffi/data.cc 49.48% 33 Missing and 16 partials ⚠️
src/node_ffi.cc 46.80% 24 Missing and 1 partial ⚠️
src/ffi/types.cc 57.57% 14 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #62762      +/-   ##
==========================================
- Coverage   89.69%   89.67%   -0.02%     
==========================================
  Files         706      706              
  Lines      218143   218334     +191     
  Branches    41730    41801      +71     
==========================================
+ Hits       195655   195793     +138     
- Misses      14401    14432      +31     
- Partials     8087     8109      +22
Files with missing lines Coverage Δ
lib/ffi.js 96.56% <100.00%> (+0.71%) ⬆️
src/node_errors.h 86.48% <ø> (ø)
src/node_ffi.h 72.72% <ø> (ø)
src/ffi/types.cc 59.61% <57.57%> (-0.06%) ⬇️
src/node_ffi.cc 69.04% <46.80%> (-0.04%) ⬇️
src/ffi/data.cc 73.28% <49.48%> (-5.50%) ⬇️

... and 55 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@meixg
Copy link
Copy Markdown
Member

meixg commented Apr 16, 2026

LGTM
One small API thought: would it be better to expose this as something like getRawReference() instead of getRawPointer(), returning both the pointer and byteLength? For byte sources, the pointer is usually
meant to be used together with its length.

@ShogunPanda
Copy link
Copy Markdown
Contributor Author

ShogunPanda commented Apr 16, 2026

@meixg I don't think it is acually necessary. When using the function you already own the source (getRawPointer(buffer)) so you can call the byteLength directly, isn't it?

@ShogunPanda ShogunPanda changed the title ffi: added new methods and error codes ffi: add new methods and error codes Apr 16, 2026
addaleax
addaleax reviewed Apr 17, 2026
View reviewed changes
Comment thread src/ffi/data.cc Outdated
Comment thread src/ffi/types.cc Outdated
Comment thread src/ffi/types.cc Outdated
Comment thread src/ffi/types.cc Outdated
Comment thread src/ffi/types.cc Outdated
Comment thread src/ffi/types.cc Outdated
Comment thread src/ffi/types.cc Outdated
Comment thread src/ffi/types.cc Outdated
Comment thread src/ffi/types.cc Outdated
Comment thread src/ffi/data.cc Outdated
addaleax
addaleax reviewed Apr 17, 2026
View reviewed changes
Comment thread src/node_ffi.cc Outdated
Comment thread src/node_ffi.cc Outdated
Comment thread src/ffi/data.cc Outdated
Comment thread src/ffi/data.cc Outdated
Comment thread src/ffi/data.cc Outdated
@ShogunPanda
fixup
d33227e 
Signed-off-by: Paolo Insogna <[email protected]>
@ShogunPanda
Copy link
Copy Markdown
Contributor Author

ShogunPanda commented Apr 18, 2026

@addaleax I think I addressed all your suggestions. Do you mind checking it again?

@nodejs-github-bot
Copy link
Copy Markdown
Collaborator

nodejs-github-bot commented Apr 18, 2026

CI: https://ci.nodejs.org/job/node-test-pull-request/72754/

@nodejs-github-bot
Copy link
Copy Markdown
Collaborator

nodejs-github-bot commented Apr 18, 2026

CI: https://ci.nodejs.org/job/node-test-pull-request/72757/

mcollina
mcollina approved these changes Apr 18, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

addaleax
addaleax approved these changes Apr 18, 2026
View reviewed changes
Comment thread doc/api/errors.md Outdated
Comment thread src/ffi/data.cc Outdated
Comment thread src/ffi/data.cc
bengl
bengl reviewed Apr 19, 2026
View reviewed changes
Comment thread src/node_ffi.cc Outdated
bengl
bengl reviewed Apr 19, 2026
View reviewed changes
Comment thread src/node_ffi.cc Outdated
@ShogunPanda
fixup
0a2bfad 
Signed-off-by: Paolo Insogna <[email protected]>
@nodejs-github-bot
Copy link
Copy Markdown
Collaborator

nodejs-github-bot commented Apr 19, 2026

CI: https://ci.nodejs.org/job/node-test-pull-request/72782/

@nodejs-github-bot
Copy link
Copy Markdown
Collaborator

nodejs-github-bot commented Apr 19, 2026

CI: https://ci.nodejs.org/job/node-test-pull-request/72785/

@ShogunPanda ShogunPanda added commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. labels Apr 19, 2026
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Apr 19, 2026
@nodejs-github-bot nodejs-github-bot merged commit 14e16db into nodejs:main Apr 19, 2026
67 checks passed
@nodejs-github-bot
Copy link
Copy Markdown
Collaborator

nodejs-github-bot commented Apr 19, 2026

Landed in 14e16db

@ShogunPanda ShogunPanda deleted the ffi-followup branch April 19, 2026 18:40
@XavierMP14 XavierMP14 mentioned this pull request Apr 19, 2026
Closed
@addaleax addaleax added the ffi Issues and PRs related to experimental Foreign Function Interface support. label Apr 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mcollina mcollina mcollina approved these changes

@bengl bengl bengl approved these changes

@addaleax addaleax addaleax approved these changes

@meixg meixg meixg approved these changes

@jasnell jasnell Awaiting requested review from jasnell

Assignees

No one assigned

Labels

commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. ffi Issues and PRs related to experimental Foreign Function Interface support. lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@ShogunPanda @nodejs-github-bot @justjake @meixg @mcollina @bengl @addaleax